<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>py3dtilers.Common.tiler API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>py3dtilers.Common.tiler</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import argparse
from pathlib import Path

from ..Common import LodTree, FromGeometryTreeToTileset, Groups
from ..Color import ColorConfig
from ..Texture import Texture
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from ..Common import FeatureList


class Tiler():

    # The kd_tree_max is the maximum number of features that the kd-tree will put in each tile.
    DEFAULT_KD_TREE_MAX = 500

    def __init__(self):
        text = &#39;&#39;&#39;A small utility that build a 3DTiles tileset out of data&#39;&#39;&#39;
        self.parser = argparse.ArgumentParser(description=text)

        self.parser.add_argument(&#39;--obj&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;When defined, also create an .obj model of the features.\
                                    The flag must be followed by the name of the obj that will be created.&#39;)

        self.parser.add_argument(&#39;--loa&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;Creates a LOA when defined. The LOA is a 3D extrusion of polygons.\
                                    Objects in the same polygon are merged together.\
                                    Must be followed by the path to directory containing the polygons .geojson&#39;)

        self.parser.add_argument(&#39;--lod1&#39;,
                                 dest=&#39;lod1&#39;,
                                 action=&#39;store_true&#39;,
                                 help=&#39;Creates a LOD1 when defined. The LOD1 is a 3D extrusion of the footprint of each object.&#39;)

        self.parser.add_argument(&#39;--offset&#39;,
                                 nargs=&#39;*&#39;,
                                 default=[0, 0, 0],
                                 help=&#39;Add an offset to all the vertices.&#39;)

        self.parser.add_argument(&#39;--scale&#39;,
                                 nargs=&#39;?&#39;,
                                 type=float,
                                 help=&#39;Scale features by the input factor.&#39;)

        self.parser.add_argument(&#39;--crs_in&#39;,
                                 nargs=&#39;?&#39;,
                                 default=&#39;EPSG:3946&#39;,
                                 type=str,
                                 help=&#39;Input projection.&#39;)

        self.parser.add_argument(&#39;--crs_out&#39;,
                                 nargs=&#39;?&#39;,
                                 default=&#39;EPSG:3946&#39;,
                                 type=str,
                                 help=&#39;Output projection.&#39;)

        self.parser.add_argument(&#39;--with_texture&#39;,
                                 dest=&#39;with_texture&#39;,
                                 action=&#39;store_true&#39;,
                                 help=&#39;Adds texture to 3DTiles when defined&#39;)

        self.parser.add_argument(&#39;--quality&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the quality of the atlas images. The minimum value is 1 and the maximum 100.\
                                    Quality can only be used with the JPEG format.&#39;)

        self.parser.add_argument(&#39;--compress_level&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the compression level of the atlas images. The minimum value is 0 and the maximum 9.\
                                    Compress level can only be used with the PNG format.&#39;)

        self.parser.add_argument(&#39;--format&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 choices=[&#39;jpg&#39;, &#39;JPG&#39;, &#39;jpeg&#39;, &#39;JPEG&#39;, &#39;png&#39;, &#39;PNG&#39;],
                                 help=&#39;Set the image file format (PNG or JPEG).&#39;)

        self.parser.add_argument(&#39;--output_dir&#39;,
                                 &#39;--out&#39;,
                                 &#39;-o&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;Output directory of the tileset.&#39;)

        self.parser.add_argument(&#39;--geometric_error&#39;,
                                 nargs=&#39;*&#39;,
                                 default=[None, None, None],
                                 help=&#39;The geometric errors of the nodes.\
                                     Used (from left ro right) for basic nodes, LOD1 nodes and LOA nodes.&#39;)

        self.parser.add_argument(&#39;--kd_tree_max&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the maximum number of features in each tile when the features are distributed by a kd-tree.\
                                     The value must be an integer.&#39;)

    def parse_command_line(self):
        self.args = self.parser.parse_args()

        if(self.args.obj is not None and &#39;.obj&#39; not in self.args.obj):
            self.args.obj = self.args.obj + &#39;.obj&#39;

        if(len(self.args.offset) &lt; 3):
            [self.args.offset.append(0) for _ in range(len(self.args.offset), 3)]
        elif(len(self.args.offset) &gt; 3):
            self.args.offset = self.args.offset[:3]
        for i, val in enumerate(self.args.offset):
            if not isinstance(val, (int, float)) and val.lstrip(&#39;-&#39;).replace(&#39;.&#39;, &#39;&#39;, 1).isdigit():
                self.args.offset[i] = float(val)

        for i, val in enumerate(self.args.geometric_error):
            self.args.geometric_error[i] = int(val) if val is not None and val.isnumeric() else None
        [self.args.geometric_error.append(None) for _ in range(len(self.args.geometric_error), 3)]

        if(self.args.quality is not None):
            Texture.set_texture_quality(self.args.quality)
        if(self.args.compress_level is not None):
            Texture.set_texture_compress_level(self.args.compress_level)
        if(self.args.format is not None):
            Texture.set_texture_format(self.args.format)

    def get_output_dir(self):
        &#34;&#34;&#34;
        Return the directory name for the tileset.
        &#34;&#34;&#34;
        if self.args.output_dir is None:
            return &#34;output_tileset&#34;
        else:
            return self.args.output_dir

    def get_kd_tree_max(self):
        &#34;&#34;&#34;
        The kd_tree_max is the maximum number of features in each tile when the features are distributed by a kd-tree.
        If the user has specified a value for the kd_tree_max argument, use that value. Otherwise, use the
        default value.
        :return: a int
        &#34;&#34;&#34;
        ktm_arg = self.args.kd_tree_max
        kd_tree_max = ktm_arg if ktm_arg is not None and ktm_arg &gt; 0 else self.DEFAULT_KD_TREE_MAX
        return kd_tree_max

    def create_tileset_from_feature_list(self, feature_list: &#39;FeatureList&#39;, extension_name=None):
        &#34;&#34;&#34;
        Create the 3DTiles tileset from the features.
        :param feature_list: a FeatureList
        :param extension_name: an optional extension to add to the tileset
        :return: a TileSet
        &#34;&#34;&#34;
        groups = Groups(feature_list, self.args.loa, self.get_kd_tree_max()).get_groups_as_list()
        feature_list.delete_features_ref()
        return self.create_tileset_from_groups(groups, extension_name)

    def create_tileset_from_groups(self, groups: Groups, extension_name=None):
        &#34;&#34;&#34;
        Create the 3DTiles tileset from the groups.
        :param groups: Groups
        :param extension_name: an optional extension to add to the tileset
        :return: a TileSet
        &#34;&#34;&#34;
        create_loa = self.args.loa is not None
        geometric_errors = self.args.geometric_error if hasattr(self.args, &#39;geometric_error&#39;) else [None, None, None]

        tree = LodTree(groups, self.args.lod1, create_loa, self.args.with_texture, geometric_errors)

        self.create_output_directory()
        return FromGeometryTreeToTileset.convert_to_tileset(tree, self.args, extension_name, self.get_output_dir())

    def create_output_directory(self):
        &#34;&#34;&#34;
        Create the directory where the tileset will be writen.
        &#34;&#34;&#34;
        dir = self.get_output_dir()
        target_dir = Path(dir).expanduser()
        Path(target_dir).mkdir(parents=True, exist_ok=True)
        target_dir = Path(dir, &#39;tiles&#39;).expanduser()
        Path(target_dir).mkdir(parents=True, exist_ok=True)
        Texture.set_texture_folder(dir)

    def get_color_config(self, config_path):
        &#34;&#34;&#34;
        Return the ColorConfig used to create the colored materials.
        :return: a ColorConfig
        &#34;&#34;&#34;
        return ColorConfig(config_path)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="py3dtilers.Common.tiler.Tiler"><code class="flex name class">
<span>class <span class="ident">Tiler</span></span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Tiler():

    # The kd_tree_max is the maximum number of features that the kd-tree will put in each tile.
    DEFAULT_KD_TREE_MAX = 500

    def __init__(self):
        text = &#39;&#39;&#39;A small utility that build a 3DTiles tileset out of data&#39;&#39;&#39;
        self.parser = argparse.ArgumentParser(description=text)

        self.parser.add_argument(&#39;--obj&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;When defined, also create an .obj model of the features.\
                                    The flag must be followed by the name of the obj that will be created.&#39;)

        self.parser.add_argument(&#39;--loa&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;Creates a LOA when defined. The LOA is a 3D extrusion of polygons.\
                                    Objects in the same polygon are merged together.\
                                    Must be followed by the path to directory containing the polygons .geojson&#39;)

        self.parser.add_argument(&#39;--lod1&#39;,
                                 dest=&#39;lod1&#39;,
                                 action=&#39;store_true&#39;,
                                 help=&#39;Creates a LOD1 when defined. The LOD1 is a 3D extrusion of the footprint of each object.&#39;)

        self.parser.add_argument(&#39;--offset&#39;,
                                 nargs=&#39;*&#39;,
                                 default=[0, 0, 0],
                                 help=&#39;Add an offset to all the vertices.&#39;)

        self.parser.add_argument(&#39;--scale&#39;,
                                 nargs=&#39;?&#39;,
                                 type=float,
                                 help=&#39;Scale features by the input factor.&#39;)

        self.parser.add_argument(&#39;--crs_in&#39;,
                                 nargs=&#39;?&#39;,
                                 default=&#39;EPSG:3946&#39;,
                                 type=str,
                                 help=&#39;Input projection.&#39;)

        self.parser.add_argument(&#39;--crs_out&#39;,
                                 nargs=&#39;?&#39;,
                                 default=&#39;EPSG:3946&#39;,
                                 type=str,
                                 help=&#39;Output projection.&#39;)

        self.parser.add_argument(&#39;--with_texture&#39;,
                                 dest=&#39;with_texture&#39;,
                                 action=&#39;store_true&#39;,
                                 help=&#39;Adds texture to 3DTiles when defined&#39;)

        self.parser.add_argument(&#39;--quality&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the quality of the atlas images. The minimum value is 1 and the maximum 100.\
                                    Quality can only be used with the JPEG format.&#39;)

        self.parser.add_argument(&#39;--compress_level&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the compression level of the atlas images. The minimum value is 0 and the maximum 9.\
                                    Compress level can only be used with the PNG format.&#39;)

        self.parser.add_argument(&#39;--format&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 choices=[&#39;jpg&#39;, &#39;JPG&#39;, &#39;jpeg&#39;, &#39;JPEG&#39;, &#39;png&#39;, &#39;PNG&#39;],
                                 help=&#39;Set the image file format (PNG or JPEG).&#39;)

        self.parser.add_argument(&#39;--output_dir&#39;,
                                 &#39;--out&#39;,
                                 &#39;-o&#39;,
                                 nargs=&#39;?&#39;,
                                 type=str,
                                 help=&#39;Output directory of the tileset.&#39;)

        self.parser.add_argument(&#39;--geometric_error&#39;,
                                 nargs=&#39;*&#39;,
                                 default=[None, None, None],
                                 help=&#39;The geometric errors of the nodes.\
                                     Used (from left ro right) for basic nodes, LOD1 nodes and LOA nodes.&#39;)

        self.parser.add_argument(&#39;--kd_tree_max&#39;,
                                 nargs=&#39;?&#39;,
                                 type=int,
                                 help=&#39;Set the maximum number of features in each tile when the features are distributed by a kd-tree.\
                                     The value must be an integer.&#39;)

    def parse_command_line(self):
        self.args = self.parser.parse_args()

        if(self.args.obj is not None and &#39;.obj&#39; not in self.args.obj):
            self.args.obj = self.args.obj + &#39;.obj&#39;

        if(len(self.args.offset) &lt; 3):
            [self.args.offset.append(0) for _ in range(len(self.args.offset), 3)]
        elif(len(self.args.offset) &gt; 3):
            self.args.offset = self.args.offset[:3]
        for i, val in enumerate(self.args.offset):
            if not isinstance(val, (int, float)) and val.lstrip(&#39;-&#39;).replace(&#39;.&#39;, &#39;&#39;, 1).isdigit():
                self.args.offset[i] = float(val)

        for i, val in enumerate(self.args.geometric_error):
            self.args.geometric_error[i] = int(val) if val is not None and val.isnumeric() else None
        [self.args.geometric_error.append(None) for _ in range(len(self.args.geometric_error), 3)]

        if(self.args.quality is not None):
            Texture.set_texture_quality(self.args.quality)
        if(self.args.compress_level is not None):
            Texture.set_texture_compress_level(self.args.compress_level)
        if(self.args.format is not None):
            Texture.set_texture_format(self.args.format)

    def get_output_dir(self):
        &#34;&#34;&#34;
        Return the directory name for the tileset.
        &#34;&#34;&#34;
        if self.args.output_dir is None:
            return &#34;output_tileset&#34;
        else:
            return self.args.output_dir

    def get_kd_tree_max(self):
        &#34;&#34;&#34;
        The kd_tree_max is the maximum number of features in each tile when the features are distributed by a kd-tree.
        If the user has specified a value for the kd_tree_max argument, use that value. Otherwise, use the
        default value.
        :return: a int
        &#34;&#34;&#34;
        ktm_arg = self.args.kd_tree_max
        kd_tree_max = ktm_arg if ktm_arg is not None and ktm_arg &gt; 0 else self.DEFAULT_KD_TREE_MAX
        return kd_tree_max

    def create_tileset_from_feature_list(self, feature_list: &#39;FeatureList&#39;, extension_name=None):
        &#34;&#34;&#34;
        Create the 3DTiles tileset from the features.
        :param feature_list: a FeatureList
        :param extension_name: an optional extension to add to the tileset
        :return: a TileSet
        &#34;&#34;&#34;
        groups = Groups(feature_list, self.args.loa, self.get_kd_tree_max()).get_groups_as_list()
        feature_list.delete_features_ref()
        return self.create_tileset_from_groups(groups, extension_name)

    def create_tileset_from_groups(self, groups: Groups, extension_name=None):
        &#34;&#34;&#34;
        Create the 3DTiles tileset from the groups.
        :param groups: Groups
        :param extension_name: an optional extension to add to the tileset
        :return: a TileSet
        &#34;&#34;&#34;
        create_loa = self.args.loa is not None
        geometric_errors = self.args.geometric_error if hasattr(self.args, &#39;geometric_error&#39;) else [None, None, None]

        tree = LodTree(groups, self.args.lod1, create_loa, self.args.with_texture, geometric_errors)

        self.create_output_directory()
        return FromGeometryTreeToTileset.convert_to_tileset(tree, self.args, extension_name, self.get_output_dir())

    def create_output_directory(self):
        &#34;&#34;&#34;
        Create the directory where the tileset will be writen.
        &#34;&#34;&#34;
        dir = self.get_output_dir()
        target_dir = Path(dir).expanduser()
        Path(target_dir).mkdir(parents=True, exist_ok=True)
        target_dir = Path(dir, &#39;tiles&#39;).expanduser()
        Path(target_dir).mkdir(parents=True, exist_ok=True)
        Texture.set_texture_folder(dir)

    def get_color_config(self, config_path):
        &#34;&#34;&#34;
        Return the ColorConfig used to create the colored materials.
        :return: a ColorConfig
        &#34;&#34;&#34;
        return ColorConfig(config_path)</code></pre>
</details>
<h3>Subclasses</h3>
<ul class="hlist">
<li>py3dtilers.CityTiler.CityTiler.CityTiler</li>
<li><a title="py3dtilers.GeojsonTiler.GeojsonTiler.GeojsonTiler" href="../GeojsonTiler/GeojsonTiler.html#py3dtilers.GeojsonTiler.GeojsonTiler.GeojsonTiler">GeojsonTiler</a></li>
<li><a title="py3dtilers.IfcTiler.IfcTiler.IfcTiler" href="../IfcTiler/IfcTiler.html#py3dtilers.IfcTiler.IfcTiler.IfcTiler">IfcTiler</a></li>
<li><a title="py3dtilers.ObjTiler.ObjTiler.ObjTiler" href="../ObjTiler/ObjTiler.html#py3dtilers.ObjTiler.ObjTiler.ObjTiler">ObjTiler</a></li>
<li><a title="py3dtilers.TilesetReader.TilesetReader.TilesetTiler" href="../TilesetReader/TilesetReader.html#py3dtilers.TilesetReader.TilesetReader.TilesetTiler">TilesetTiler</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="py3dtilers.Common.tiler.Tiler.DEFAULT_KD_TREE_MAX"><code class="name">var <span class="ident">DEFAULT_KD_TREE_MAX</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="py3dtilers.Common.tiler.Tiler.create_output_directory"><code class="name flex">
<span>def <span class="ident">create_output_directory</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Create the directory where the tileset will be writen.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_output_directory(self):
    &#34;&#34;&#34;
    Create the directory where the tileset will be writen.
    &#34;&#34;&#34;
    dir = self.get_output_dir()
    target_dir = Path(dir).expanduser()
    Path(target_dir).mkdir(parents=True, exist_ok=True)
    target_dir = Path(dir, &#39;tiles&#39;).expanduser()
    Path(target_dir).mkdir(parents=True, exist_ok=True)
    Texture.set_texture_folder(dir)</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.create_tileset_from_feature_list"><code class="name flex">
<span>def <span class="ident">create_tileset_from_feature_list</span></span>(<span>self, feature_list: FeatureList, extension_name=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Create the 3DTiles tileset from the features.
:param feature_list: a FeatureList
:param extension_name: an optional extension to add to the tileset
:return: a TileSet</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_tileset_from_feature_list(self, feature_list: &#39;FeatureList&#39;, extension_name=None):
    &#34;&#34;&#34;
    Create the 3DTiles tileset from the features.
    :param feature_list: a FeatureList
    :param extension_name: an optional extension to add to the tileset
    :return: a TileSet
    &#34;&#34;&#34;
    groups = Groups(feature_list, self.args.loa, self.get_kd_tree_max()).get_groups_as_list()
    feature_list.delete_features_ref()
    return self.create_tileset_from_groups(groups, extension_name)</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.create_tileset_from_groups"><code class="name flex">
<span>def <span class="ident">create_tileset_from_groups</span></span>(<span>self, groups: <a title="py3dtilers.Common.group.Groups" href="group.html#py3dtilers.Common.group.Groups">Groups</a>, extension_name=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Create the 3DTiles tileset from the groups.
:param groups: Groups
:param extension_name: an optional extension to add to the tileset
:return: a TileSet</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def create_tileset_from_groups(self, groups: Groups, extension_name=None):
    &#34;&#34;&#34;
    Create the 3DTiles tileset from the groups.
    :param groups: Groups
    :param extension_name: an optional extension to add to the tileset
    :return: a TileSet
    &#34;&#34;&#34;
    create_loa = self.args.loa is not None
    geometric_errors = self.args.geometric_error if hasattr(self.args, &#39;geometric_error&#39;) else [None, None, None]

    tree = LodTree(groups, self.args.lod1, create_loa, self.args.with_texture, geometric_errors)

    self.create_output_directory()
    return FromGeometryTreeToTileset.convert_to_tileset(tree, self.args, extension_name, self.get_output_dir())</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.get_color_config"><code class="name flex">
<span>def <span class="ident">get_color_config</span></span>(<span>self, config_path)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the ColorConfig used to create the colored materials.
:return: a ColorConfig</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_color_config(self, config_path):
    &#34;&#34;&#34;
    Return the ColorConfig used to create the colored materials.
    :return: a ColorConfig
    &#34;&#34;&#34;
    return ColorConfig(config_path)</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.get_kd_tree_max"><code class="name flex">
<span>def <span class="ident">get_kd_tree_max</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>The kd_tree_max is the maximum number of features in each tile when the features are distributed by a kd-tree.
If the user has specified a value for the kd_tree_max argument, use that value. Otherwise, use the
default value.
:return: a int</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_kd_tree_max(self):
    &#34;&#34;&#34;
    The kd_tree_max is the maximum number of features in each tile when the features are distributed by a kd-tree.
    If the user has specified a value for the kd_tree_max argument, use that value. Otherwise, use the
    default value.
    :return: a int
    &#34;&#34;&#34;
    ktm_arg = self.args.kd_tree_max
    kd_tree_max = ktm_arg if ktm_arg is not None and ktm_arg &gt; 0 else self.DEFAULT_KD_TREE_MAX
    return kd_tree_max</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.get_output_dir"><code class="name flex">
<span>def <span class="ident">get_output_dir</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Return the directory name for the tileset.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_output_dir(self):
    &#34;&#34;&#34;
    Return the directory name for the tileset.
    &#34;&#34;&#34;
    if self.args.output_dir is None:
        return &#34;output_tileset&#34;
    else:
        return self.args.output_dir</code></pre>
</details>
</dd>
<dt id="py3dtilers.Common.tiler.Tiler.parse_command_line"><code class="name flex">
<span>def <span class="ident">parse_command_line</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def parse_command_line(self):
    self.args = self.parser.parse_args()

    if(self.args.obj is not None and &#39;.obj&#39; not in self.args.obj):
        self.args.obj = self.args.obj + &#39;.obj&#39;

    if(len(self.args.offset) &lt; 3):
        [self.args.offset.append(0) for _ in range(len(self.args.offset), 3)]
    elif(len(self.args.offset) &gt; 3):
        self.args.offset = self.args.offset[:3]
    for i, val in enumerate(self.args.offset):
        if not isinstance(val, (int, float)) and val.lstrip(&#39;-&#39;).replace(&#39;.&#39;, &#39;&#39;, 1).isdigit():
            self.args.offset[i] = float(val)

    for i, val in enumerate(self.args.geometric_error):
        self.args.geometric_error[i] = int(val) if val is not None and val.isnumeric() else None
    [self.args.geometric_error.append(None) for _ in range(len(self.args.geometric_error), 3)]

    if(self.args.quality is not None):
        Texture.set_texture_quality(self.args.quality)
    if(self.args.compress_level is not None):
        Texture.set_texture_compress_level(self.args.compress_level)
    if(self.args.format is not None):
        Texture.set_texture_format(self.args.format)</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="py3dtilers.Common" href="index.html">py3dtilers.Common</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="py3dtilers.Common.tiler.Tiler" href="#py3dtilers.Common.tiler.Tiler">Tiler</a></code></h4>
<ul class="">
<li><code><a title="py3dtilers.Common.tiler.Tiler.DEFAULT_KD_TREE_MAX" href="#py3dtilers.Common.tiler.Tiler.DEFAULT_KD_TREE_MAX">DEFAULT_KD_TREE_MAX</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_output_directory" href="#py3dtilers.Common.tiler.Tiler.create_output_directory">create_output_directory</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_tileset_from_feature_list" href="#py3dtilers.Common.tiler.Tiler.create_tileset_from_feature_list">create_tileset_from_feature_list</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.create_tileset_from_groups" href="#py3dtilers.Common.tiler.Tiler.create_tileset_from_groups">create_tileset_from_groups</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_color_config" href="#py3dtilers.Common.tiler.Tiler.get_color_config">get_color_config</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_kd_tree_max" href="#py3dtilers.Common.tiler.Tiler.get_kd_tree_max">get_kd_tree_max</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.get_output_dir" href="#py3dtilers.Common.tiler.Tiler.get_output_dir">get_output_dir</a></code></li>
<li><code><a title="py3dtilers.Common.tiler.Tiler.parse_command_line" href="#py3dtilers.Common.tiler.Tiler.parse_command_line">parse_command_line</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>